feat: improve member api for brb, update test-app with brb #4027

antsukanova · 2024-12-13T10:49:53Z

COMPLETES # SPARK-574653

This pull request addresses

Implements test-app UI changes for better testing purposes of step away feature, adds new member property isBrb for better work with getting this data from the locus.

by making the following changes

Adds a new participant list table column that displays the new away state and adds the possibility of changing the away state for the current user.

Change Type

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
Tooling change
Internal code refactor

The following scenarios were tested

tested manually using test-app with convergedats account, checked work of existing test cases

I certified that

I have read and followed contributing guidelines
I discussed changes with code owners prior to submitting this pull request
I have not skipped any automated checks
All existing and new tests passed
I have updated the documentation accordingly

Make sure to have followed the contributing guidelines before submitting.

coderabbitai · 2024-12-13T10:50:00Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

edvujic

Changes look good, left some comments.

docs/samples/browser-plugin-meetings/app.js

packages/@webex/plugin-meetings/src/member/util.ts

packages/@webex/plugin-meetings/test/unit/spec/member/util.js

docs/samples/browser-plugin-meetings/app.js

brycetham · 2024-12-13T13:33:35Z

docs/samples/browser-plugin-meetings/app.js

@@ -3780,11 +3791,19 @@ function createMembersTable(members) {

    td5.appendChild(label5);

+
+    if (isCurrentUser(member)) {
+      td6.appendChild(createButton(member.isBrb ? 'Remove away' : 'Apply away', toggleBrb, {id: 'brb-btn'}));


I would change the wording here to "Step Away" and "Back to Meeting". That just seems the most clear to me, and having it match the client UI makes it easy to understand that this is mapped to the step away feature.

@brycetham I have tried this combination, but I don't like that "Back to Meeting" span on two lines and I can't do a style fix for that easily, I need to change the style for the table, not sure if this is worth that, but I'm open to discuss

brycetham · 2024-12-13T13:45:59Z

packages/@webex/plugin-meetings/src/member/types.ts

+export type ParticipantWithBrb = {
+  controls?: {
+    brb?: {
+      enabled: boolean;
+    };
+  };
+};


I'm just looking at ParticipantWithRoles... in that type, neither controls nor role is optional, so I just want to double check that we do want controls and brb to both be optional here.

@brycetham good point. I believe this type is wrong, because I reused this function getControlsRoles logic and it contains optional chaining inside, so I assume it can be undefined but the type doesn't show that. For example, when this brb feature doesn't work I believe it can be optional. In most cases in code logic when they deal with controls logic we have undefined checks.

@brycetham I couldn't find information in the locus dto documents, so I will remove the optional parameter since none of my test cases require it to be optional.

packages/@webex/plugin-meetings/src/member/util.ts

edvujic

LGTM, thanks!

brycetham

Approved 👍 But I noticed #4027 (comment) wasn't resolved yet... not sure if you meant to resolve it and forgot to push, or if you did not plan on changing anything here.

antsukanova · 2024-12-18T09:54:29Z

@brycetham Sorry for not explaining this clearly, I forgot to answer in more detail why I haven't updated this type. I have tested that brb is 100% possible to be undefined, but I haven't had a situation easily in a test app where controls can't be undefined, and seeing that in many functions SDK contains checks for controls I kept it. I will discuss this logic for type in sdk PR, but for now, I leave type with optional details

feat: add logic to sdk test app

118936a

antsukanova self-assigned this Dec 13, 2024

antsukanova added the validated If the pull request is validated for automation. label Dec 13, 2024

antsukanova marked this pull request as ready for review December 13, 2024 10:51

antsukanova requested review from a team as code owners December 13, 2024 10:51

antsukanova requested review from szotrabh, brycetham, SomeBody16, k-wasniowski and edvujic December 13, 2024 10:53

edvujic reviewed Dec 13, 2024

View reviewed changes

k-wasniowski approved these changes Dec 13, 2024

View reviewed changes

szotrabh reviewed Dec 13, 2024

View reviewed changes

docs/samples/browser-plugin-meetings/app.js Show resolved Hide resolved

brycetham reviewed Dec 13, 2024

View reviewed changes

fix: add fixes for PR

53df0d0

antsukanova requested a review from edvujic December 13, 2024 14:31

edvujic approved these changes Dec 13, 2024

View reviewed changes

chore: update isBrb

c84ed07

antsukanova requested review from brycetham and szotrabh December 16, 2024 18:45

brycetham approved these changes Dec 17, 2024

View reviewed changes

antsukanova merged commit 46229db into webex:brb-feature Dec 18, 2024
12 checks passed

antsukanova deleted the antsukan/SPARK-574653 branch December 18, 2024 09:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: improve member api for brb, update test-app with brb #4027

feat: improve member api for brb, update test-app with brb #4027

antsukanova commented Dec 13, 2024 •

edited

Loading

coderabbitai bot commented Dec 13, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

edvujic left a comment

brycetham Dec 13, 2024

antsukanova Dec 13, 2024

brycetham Dec 13, 2024

antsukanova Dec 13, 2024

antsukanova Dec 16, 2024

edvujic left a comment

brycetham left a comment

antsukanova commented Dec 18, 2024

feat: improve member api for brb, update test-app with brb #4027

feat: improve member api for brb, update test-app with brb #4027

Conversation

antsukanova commented Dec 13, 2024 • edited Loading

COMPLETES # SPARK-574653

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

I certified that

coderabbitai bot commented Dec 13, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

edvujic left a comment

Choose a reason for hiding this comment

brycetham Dec 13, 2024

Choose a reason for hiding this comment

antsukanova Dec 13, 2024

Choose a reason for hiding this comment

brycetham Dec 13, 2024

Choose a reason for hiding this comment

antsukanova Dec 13, 2024

Choose a reason for hiding this comment

antsukanova Dec 16, 2024

Choose a reason for hiding this comment

edvujic left a comment

Choose a reason for hiding this comment

brycetham left a comment

Choose a reason for hiding this comment

antsukanova commented Dec 18, 2024

antsukanova commented Dec 13, 2024 •

edited

Loading

coderabbitai bot commented Dec 13, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)